Package-level declarations

Types

Mutable abort source — the v6 equivalent of AbortController. Hold the controller, hand the signal to the agent, call abort from the UI's stop button.

AbortError

class AbortError(message: String = "operation aborted") : CancellationException

Thrown from AbortSignal.throwIfAborted when the signal has fired.

AbortSignal

interface AbortSignal

Cancellation primitive matching the Vercel AI SDK v6 AbortSignal shape.

Agent

interface Agent<TContext, TOutput>

The agent contract — what application code depends on (best practice #7). ToolLoopAgent is the default implementation, but other implementations exist (e.g. a DurableAgent that journals to disk for offline-resilient mode, a SubagentTestAgent that records calls for unit tests).

AgentCallHooks

data class AgentCallHooks(val onStart: suspend (OnStartEvent) -> Unit? = null, val onStepStart: suspend (OnStepStartEvent) -> Unit? = null, val onStepFinish: suspend (OnStepFinishEvent) -> Unit? = null, val onFinish: suspend (OnFinishEvent) -> Unit? = null, val onError: suspend (OnErrorEvent) -> Unit? = null, val onChunk: suspend (OnChunkEvent) -> Unit? = null, val onAbort: suspend (OnAbortEvent) -> Unit? = null, val experimental_onToolCallStart: suspend (OnToolCallStartEvent) -> Unit? = null, val experimental_onToolCallFinish: suspend (OnToolCallFinishEvent) -> Unit? = null)

Per-call lifecycle hooks. These mirror the ones on the agent constructor but apply to a single Agent.generate / Agent.stream invocation — useful for request-scoped logging, tracing, or progress UI.

AgentError

sealed class AgentError : RuntimeException

Tool-loop error taxonomy (Phase 4C gap #25). The agent loop's failure modes were previously all String messages on StreamEvent.Error / StreamEvent.ToolError; catch sites had no way to discriminate "model called an unknown tool" from "executor threw" from "input decode failed" without parsing the message.

AgentSession

class AgentSession<TContext, TOutput>(scope: CoroutineScope, agent: Agent<TContext, TOutput>, initialMessages: List<ModelMessage> = emptyList())

AgentSessionState

data class AgentSessionState<TOutput>(val messages: List<ModelMessage> = emptyList(), val status: AgentSessionStatus = AgentSessionStatus.Ready, val text: String = "", val output: TOutput? = null, val pendingApprovals: List<PendingApproval> = emptyList(), val lastResult: GenerateResult<TOutput>? = null, val error: Throwable? = null)

AgentSessionStatus

enum AgentSessionStatus : Enum<AgentSessionStatus>

AgentSettings

data class AgentSettings<TContext>(val instructions: String? = null, val model: LanguageModel? = null, val tools: ToolSet<TContext>? = null, val activeTools: List<String>? = null, val providerOptions: Map<String, JsonElement>? = null, val temperature: Float? = null, val topP: Float? = null, val topK: Int? = null, val maxOutputTokens: Int? = null, val stopSequences: List<String>? = null, val seed: Int? = null, val presencePenalty: Float? = null, val frequencyPenalty: Float? = null, val responseFormat: ResponseFormat? = null)

Returned from prepareCall. Any non-null field overrides the agent default for this invocation only.

AiSdkDsl

@DslMarker

annotation class AiSdkDsl

Marks AI SDK builder receivers so nested DSL blocks don't leak outer scopes.

AISDKError

typealias AISDKError = AiSdkException

AiSdkException

open class AiSdkException(message: String, cause: Throwable? = null) : RuntimeException

APICallError

class APICallError(message: String, val url: String, val requestBodyValues: Any? = null, val statusCode: Int? = null, val responseHeaders: Map<String, String>? = null, val responseBody: String? = null, cause: Throwable? = null, val isRetryable: Boolean = statusCode == 408 || statusCode == 409 || statusCode == 429 || (statusCode ?: 0) >= 500, val data: Any? = null) : AiSdkException

AudioSource

data class AudioSource(val mediaType: String, val base64: String, val filename: String? = null)

AuthOptions

data class AuthOptions(val serverUrl: String, val authorizationCode: String? = null, val callbackState: String? = null, val scope: String? = null, val resourceMetadataUrl: String? = null, val client: HttpClient? = null)

AuthorizationServerMetadata

@Serializable

data class AuthorizationServerMetadata(val issuer: String? = null, val authorizationEndpoint: String? = null, val tokenEndpoint: String? = null, val registrationEndpoint: String? = null, val responseTypesSupported: List<String>? = null, val grantTypesSupported: List<String>? = null, val tokenEndpointAuthMethodsSupported: List<String>? = null, val codeChallengeMethodsSupported: List<String>? = null)

AuthResult

enum AuthResult : Enum<AuthResult>

CallCompletionApiOptions

data class CallCompletionApiOptions(val api: String = "/api/completion", val id: String = generateId("completion"), val prompt: String, val headers: Map<String, String> = emptyMap(), val body: Map<String, JsonElement> = emptyMap(), val streamProtocol: CompletionStreamProtocol = CompletionStreamProtocol.Data, val transport: CompletionTransport, val abortSignal: AbortSignal = AbortSignalNever, val setCompletion: (String) -> Unit = {}, val setLoading: (Boolean) -> Unit = {}, val setError: (Throwable?) -> Unit = {}, val onFinish: suspend (prompt: String, completion: String) -> Unit = { _, _ -> }, val onError: suspend (Throwable) -> Unit = {})

CallSettings

data class CallSettings(val temperature: Float? = null, val topP: Float? = null, val topK: Int? = null, val maxOutputTokens: Int? = null, val stopSequences: List<String>? = null, val seed: Int? = null, val providerOptions: Map<String, JsonElement> = emptyMap(), val abortSignal: AbortSignal? = null, val presencePenalty: Float? = null, val frequencyPenalty: Float? = null, val responseFormat: ResponseFormat? = null)

CallSettingsBuilder

class CallSettingsBuilder

CallToolResult

@Serializable

data class CallToolResult(val content: List<JsonObject> = emptyList(), val structuredContent: JsonElement? = null, val isError: Boolean = false, val toolResult: JsonElement? = null, val meta: JsonObject? = null)

CallWarning

@Serializable

data class CallWarning(val type: String, val message: String? = null, val details: JsonElement? = null)

Provider warning for a call that still completed. Mirrors v6's CallWarning shape without baking provider-specific warning enums into common code.

ChunkBy

sealed interface ChunkBy

Smooths text/reasoning streaming output by buffering until a chunk boundary, then releasing complete chunks with a configurable delay.

Completion

class Completion(options: UseCompletionOptions = UseCompletionOptions())

CompletionRequest

data class CompletionRequest(val api: String, val id: String, val prompt: String, val headers: Map<String, String> = emptyMap(), val body: Map<String, JsonElement> = emptyMap(), val streamProtocol: CompletionStreamProtocol = CompletionStreamProtocol.Data, val abortSignal: AbortSignal = AbortSignalNever)

CompletionRequestOptions

data class CompletionRequestOptions(val headers: Map<String, String> = emptyMap(), val body: Map<String, JsonElement> = emptyMap())

CompletionStreamProtocol

enum CompletionStreamProtocol : Enum<CompletionStreamProtocol>

CompletionTransport

interface CompletionTransport

Configuration

@Serializable

data class Configuration(val name: String, val version: String, val title: String? = null)

ContentPart

@Serializable

sealed interface ContentPart

Content part of a ModelMessage. Sealed so consumers exhaust over variants — adding a new content type forces a compile error at every dispatch site.

CustomProvider

data class CustomProvider(val providerId: String, languageModels: Map<String, LanguageModel> = emptyMap(), embeddingModels: Map<String, EmbeddingModel> = emptyMap(), imageModels: Map<String, ImageModel> = emptyMap(), speechModels: Map<String, SpeechModel> = emptyMap(), transcriptionModels: Map<String, TranscriptionModel> = emptyMap(), rerankingModels: Map<String, RerankingModel> = emptyMap(), videoModels: Map<String, VideoModel> = emptyMap(), fallbackProvider: Provider? = null) : Provider

DataUrl

data class DataUrl(val mediaType: String, val base64: String)

DeepPartial

data class DeepPartial<T>(val value: T?)

DefaultGeneratedFile

class DefaultGeneratedFile

DevToolsRecorder

interface DevToolsRecorder

DevToolsStep

data class DevToolsStep(val id: String, val runId: String, val stepNumber: Int, val type: String, val modelId: String, val provider: String, val input: JsonElement, val providerOptions: Map<String, JsonElement>)

DevToolsStepResult

data class DevToolsStepResult(val durationMs: Long, val output: JsonElement?, val usage: Usage?, val error: String?, val rawRequest: JsonElement? = null, val rawResponse: JsonElement? = null, val rawChunks: List<JsonElement> = emptyList())

DirectCompletionTransport

class DirectCompletionTransport(handler: (CompletionRequest) -> Flow<String>) : CompletionTransport

DirectStructuredObjectTransport

class DirectStructuredObjectTransport<INPUT>(handler: (StructuredObjectRequest<INPUT>) -> Flow<String>) : StructuredObjectTransport<INPUT>

DownloadedAsset

data class DownloadedAsset(val base64: String, val mediaType: String?)

The base64 bytes + media type of a downloaded asset.

DownloadError

class DownloadError(val url: String, message: String, val statusCode: Int? = null, val statusText: String? = null, cause: Throwable? = null) : AiSdkException

DownloadFunction

typealias DownloadFunction = suspend (url: String) -> DownloadedAsset

Downloads a remote asset for convertToLanguageModelPrompt.

ElicitationCapability

@Serializable

data class ElicitationCapability(val applyDefaults: Boolean? = null)

ElicitationRequest

@Serializable

data class ElicitationRequest(val params: ElicitationRequestParams, val method: String = "elicitation/create")

ElicitationRequestParams

@Serializable

data class ElicitationRequestParams(val message: String, val requestedSchema: JsonElement, val meta: JsonObject? = null)

ElicitationRequestSchema

object ElicitationRequestSchema

ElicitResult

@Serializable

data class ElicitResult(val action: String, val content: JsonObject? = null, val meta: JsonObject? = null)

ElicitResultSchema

object ElicitResultSchema

EmbeddingMiddlewareCallContext

data class EmbeddingMiddlewareCallContext(val params: EmbeddingModelCallParams, val model: EmbeddingModel, val doEmbed: suspend (EmbeddingModelCallParams) -> EmbeddingModelResult)

EmbeddingModel

interface EmbeddingModel

EmbeddingModelCallParams

data class EmbeddingModelCallParams(val values: List<String>, val maxEmbeddingsPerCall: Int? = null, val truncate: Boolean? = null, val providerOptions: Map<String, JsonElement> = emptyMap(), val abortSignal: AbortSignal = AbortSignalNever, val headers: Map<String, String> = emptyMap())

EmbeddingModelMiddleware

interface EmbeddingModelMiddleware

EmbeddingModelResult

data class EmbeddingModelResult(val embeddings: List<List<Float>>, val usage: EmbeddingUsage = EmbeddingUsage(), val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap())

EmbeddingUsage

data class EmbeddingUsage(val tokens: Int = 0, val raw: JsonElement? = null)

EmbedManyResult

data class EmbedManyResult<TValue>(val values: List<TValue>, val embeddings: List<List<Float>>, val usage: EmbeddingUsage, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val responses: List<LanguageModelResponseMetadata> = emptyList(), val providerMetadata: Map<String, JsonElement> = emptyMap())

EmbedResult

data class EmbedResult<TValue>(val value: TValue, val embedding: List<Float>, val usage: EmbeddingUsage, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap())

EmptyResponseBodyError

class EmptyResponseBodyError(message: String = "Empty response body") : AiSdkException

ExecuteToolResult

sealed interface ExecuteToolResult<out TOutput>

Experimental_GeneratedImage

typealias Experimental_GeneratedImage = GeneratedFile

Experimental_GenerateImageResult

typealias Experimental_GenerateImageResult = GenerateImageResult

experimental_MCPClient

typealias experimental_MCPClient = MCPClient

experimental_MCPClientCapabilities

typealias experimental_MCPClientCapabilities = MCPClientCapabilities

experimental_MCPClientConfig

typealias experimental_MCPClientConfig = MCPClientConfig

Experimental_SpeechResult

typealias Experimental_SpeechResult = GenerateSpeechResult

Experimental_StdioMCPTransport

class Experimental_StdioMCPTransport(val config: StdioConfig, engineContext: CoroutineContext = Dispatchers.Default) : MCPTransport

Experimental_TranscriptionResult

typealias Experimental_TranscriptionResult = TranscribeResult

ExperimentalAiSdkApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an experimental AI SDK API (framework-adapter / migration surface). It may change or be removed without notice. Opt in with @OptIn(ExperimentalAiSdkApi::class).")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalAiSdkApi

Marks a declaration as experimental: a surface whose shape may change or be removed in any release without going through the normal deprecation cycle.

FileData

sealed interface FileData

FinishReason

@Serializable

enum FinishReason : Enum<FinishReason>

Why a generation step ended.

GatewayAuthenticationError

class GatewayAuthenticationError(message: String = "Authentication failed", statusCode: Int = 401, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayAuthMethod

enum GatewayAuthMethod : Enum<GatewayAuthMethod>

GatewayAuthToken

data class GatewayAuthToken(val token: String, val authMethod: GatewayAuthMethod)

GatewayCredentialType

enum GatewayCredentialType : Enum<GatewayCredentialType>

GatewayCreditsResponse

data class GatewayCreditsResponse(val balance: String, val totalUsed: String)

GatewayEmbeddingModelId

typealias GatewayEmbeddingModelId = String

GatewayError

open class GatewayError(message: String, val statusCode: Int = 500, val type: String = "gateway_error", val generationId: String? = null, cause: Throwable? = null, val isRetryable: Boolean = statusCode == 408 || statusCode == 409 || statusCode == 429 || statusCode >= 500) : AiSdkException

GatewayFetchMetadataResponse

data class GatewayFetchMetadataResponse(val models: List<GatewayLanguageModelEntry>)

GatewayGenerationInfo

data class GatewayGenerationInfo(val id: String, val totalCost: Double, val upstreamInferenceCost: Double, val usage: Double, val createdAt: String, val model: String, val isByok: Boolean, val providerName: String, val streamed: Boolean, val finishReason: String, val latency: Int, val generationTime: Int, val promptTokens: Int, val completionTokens: Int, val reasoningTokens: Int, val cachedTokens: Int, val cacheCreationTokens: Int, val billableWebSearchCalls: Int)

GatewayGenerationInfoParams

data class GatewayGenerationInfoParams(val id: String)

GatewayImageModelId

typealias GatewayImageModelId = String

GatewayInternalServerError

class GatewayInternalServerError(message: String = "Internal server error", statusCode: Int = 500, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayInvalidRequestError

class GatewayInvalidRequestError(message: String = "Invalid request", statusCode: Int = 400, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayLanguageModelEntry

data class GatewayLanguageModelEntry(val id: String, val name: String, val description: String? = null, val pricing: GatewayPricing? = null, val specification: GatewayLanguageModelSpecification, val modelType: GatewayModelType? = null)

GatewayLanguageModelSpecification

data class GatewayLanguageModelSpecification(val specificationVersion: String = "v3", val provider: String, val modelId: String)

GatewayModelEntry

typealias GatewayModelEntry = GatewayLanguageModelEntry

GatewayModelId

typealias GatewayModelId = String

GatewayModelNotFoundError

class GatewayModelNotFoundError(message: String = "Model not found", statusCode: Int = 404, val modelId: String? = null, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayModelType

enum GatewayModelType : Enum<GatewayModelType>

GatewayPricing

data class GatewayPricing(val input: String, val output: String, val cachedInputTokens: String? = null, val cacheCreationInputTokens: String? = null)

GatewayProvider

interface GatewayProvider : Provider

GatewayProviderSettings

data class GatewayProviderSettings(val baseUrl: String = AI_GATEWAY_DEFAULT_BASE_URL, val apiKey: String? = null, val headers: Map<String, String> = emptyMap(), val transport: GatewayTransport = GatewayTransportNotConfigured, val metadataCacheRefreshMillis: Long = 5 * 60 * 1000L, val nowMillis: () -> Long = { Clock.System.now().toEpochMilliseconds() }, val authTokenProvider: suspend () -> GatewayAuthToken?? = null, val environment: Map<String, String> = emptyMap())

GatewayRateLimitError

class GatewayRateLimitError(message: String = "Rate limit exceeded", statusCode: Int = 429, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayRequestContext

data class GatewayRequestContext(val baseUrl: String, val headers: Map<String, String>)

GatewayRerankingModelId

typealias GatewayRerankingModelId = String

GatewayResponseError

class GatewayResponseError(message: String = "Invalid response from Gateway", statusCode: Int = 502, val response: JsonElement? = null, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewaySpendReportDatePart

enum GatewaySpendReportDatePart : Enum<GatewaySpendReportDatePart>

GatewaySpendReportGroupBy

enum GatewaySpendReportGroupBy : Enum<GatewaySpendReportGroupBy>

GatewaySpendReportParams

data class GatewaySpendReportParams(val startDate: String, val endDate: String, val groupBy: GatewaySpendReportGroupBy? = null, val datePart: GatewaySpendReportDatePart? = null, val userId: String? = null, val model: String? = null, val provider: String? = null, val credentialType: GatewayCredentialType? = null, val tags: List<String> = emptyList())

GatewaySpendReportResponse

data class GatewaySpendReportResponse(val results: List<GatewaySpendReportRow>)

GatewaySpendReportRow

data class GatewaySpendReportRow(val day: String? = null, val hour: String? = null, val user: String? = null, val model: String? = null, val tag: String? = null, val provider: String? = null, val credentialType: GatewayCredentialType? = null, val totalCost: Double, val marketCost: Double? = null, val inputTokens: Int? = null, val outputTokens: Int? = null, val cachedInputTokens: Int? = null, val cacheCreationInputTokens: Int? = null, val reasoningTokens: Int? = null, val requestCount: Int? = null)

GatewayTimeoutError

class GatewayTimeoutError(message: String = "Gateway request timed out", statusCode: Int = 408, generationId: String? = null, cause: Throwable? = null) : GatewayError

GatewayTools

data class GatewayTools(val parallelSearch: Tool<JsonElement, JsonElement, Any?> = providerExecutedTool( name = "parallelSearch", description = "Search the web using Parallel AI's Search API for LLM-optimized excerpts.", inputSerializer = JsonElement.serializer(), outputSerializer = JsonElement.serializer(), ), val perplexitySearch: Tool<JsonElement, JsonElement, Any?> = providerExecutedTool( name = "perplexitySearch", description = "Search the web using Perplexity's Search API for real-time information.", inputSerializer = JsonElement.serializer(), outputSerializer = JsonElement.serializer(), ))

GatewayTransport

interface GatewayTransport

GatewayTransportNotConfigured

data object GatewayTransportNotConfigured : GatewayTransport

GatewayTransportNotConfiguredError

class GatewayTransportNotConfiguredError : AiSdkException

GatewayVideoModelId

typealias GatewayVideoModelId = String

GeneratedAudioFile

typealias GeneratedAudioFile = GeneratedFile

GeneratedFile

data class GeneratedFile(val mediaType: String, val base64: String, val filename: String? = null, val providerMetadata: Map<String, JsonElement> = emptyMap(), val url: String? = null)

GenerateImageResult

data class GenerateImageResult(val images: List<GeneratedFile>, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap(), val responses: List<LanguageModelResponseMetadata> = listOf(response), val usage: ImageModelUsage = ImageModelUsage())

GenerateObjectResult

data class GenerateObjectResult<TOutput>(val value: TOutput, val text: String, val reasoning: String? = null, val finishReason: FinishReason, val usage: Usage, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap())

GenerateResult

data class GenerateResult<TOutput>(val output: TOutput, val text: String, val steps: List<StepResult>, val finishReason: FinishReason, val usage: Usage, val totalUsage: Usage = usage, val pendingApprovals: List<PendingApproval> = emptyList(), val messages: List<ModelMessage> = emptyList())

Final output of Agent.generate. When pendingApprovals is non-empty, the loop paused on tool approval — call Agent.generate again with messages plus tool-approval-response messages to resume.

GenerateSpeechResult

data class GenerateSpeechResult(val audio: GeneratedFile, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap(), val responses: List<LanguageModelResponseMetadata> = listOf(response))

GenerateTextResult

data class GenerateTextResult<TOutput>(val output: TOutput, val text: String, val toolCalls: List<ContentPart.ToolCall>, val finishReason: FinishReason, val usage: Usage, val content: List<ContentPart> = buildList { if (text.isNotEmpty()) add(ContentPart.Text(text)) addAll(toolCalls) }, val toolResults: List<ContentPart.ToolResult> = content.filterIsInstance<ContentPart.ToolResult>(), val reasoning: List<ContentPart.Reasoning> = content.filterIsInstance<ContentPart.Reasoning>(), val reasoningText: String? = reasoning.takeIf { it.isNotEmpty() }?.joinToString("") { it.text }, val files: List<ContentPart.File> = content.filterIsInstance<ContentPart.File>(), val sources: List<ContentPart.Source> = content.filterIsInstance<ContentPart.Source>(), val totalUsage: Usage = usage, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap(), val steps: List<StepResult> = emptyList(), val rawFinishReason: String? = null)

GenerateVideoResult

data class GenerateVideoResult(val videos: List<GeneratedFile>, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap(), val responses: List<LanguageModelResponseMetadata> = listOf(response))

GetPromptResult

@Serializable

data class GetPromptResult(val messages: List<MCPPromptMessage>, val description: String? = null, val meta: JsonObject? = null)

HttpMCPTransport

class HttpMCPTransport(client: HttpClient, url: String, headers: Map<String, String> = emptyMap(), authProvider: OAuthClientProvider? = null, engineContext: CoroutineContext = Dispatchers.Default) : MCPTransport

IdGenerator

data class IdGenerator(val prefix: String? = null, val size: Int = 16, val alphabet: String = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", val separator: String = "-", val random: Random = Random.Default)

ImageGenerationFile

data class ImageGenerationFile(val mediaType: String? = null, val base64: String? = null, val url: String? = null, val filename: String? = null)

ImageGenerationParams

data class ImageGenerationParams(val prompt: String, val n: Int = 1, val size: String? = null, val aspectRatio: String? = null, val seed: Int? = null, val providerOptions: Map<String, JsonElement> = emptyMap(), val headers: Map<String, String> = emptyMap(), val abortSignal: AbortSignal = AbortSignalNever, val files: List<ImageGenerationFile> = emptyList(), val mask: ImageGenerationFile? = null)

ImageMiddlewareCallContext

data class ImageMiddlewareCallContext(val params: ImageGenerationParams, val model: ImageModel, val doGenerate: suspend (ImageGenerationParams) -> ImageModelResult)

ImageModel

interface ImageModel

ImageModelMiddleware

interface ImageModelMiddleware

ImageModelResult

data class ImageModelResult(val images: List<GeneratedFile>, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap(), val usage: ImageModelUsage = ImageModelUsage())

ImageModelUsage

data class ImageModelUsage(val inputTokens: Int? = null, val outputTokens: Int? = null, val totalTokens: Int? = null)

Token usage reported by an image model, when available. Mirrors v6's ImageModelUsage.

InitializeResult

@Serializable

data class InitializeResult(val protocolVersion: String, val capabilities: MCPServerCapabilities = MCPServerCapabilities(), val serverInfo: Configuration, val instructions: String? = null, val meta: JsonObject? = null)

InMemoryDevToolsRecorder

class InMemoryDevToolsRecorder : DevToolsRecorder

InMemoryTelemetryTracer

class InMemoryTelemetryTracer : TelemetryTracer

InternalAiSdkApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an internal AI SDK API and is not part of the public contract. It may change or be removed without notice. Opt in with @OptIn(InternalAiSdkApi::class).")

annotation class InternalAiSdkApi

Marks a declaration as internal to the AI SDK implementation: visible across module boundaries for technical reasons (KMP source sets, inlining), but not part of the supported public contract. It may change or be removed at any time.

InvalidArgumentError

class InvalidArgumentError(val argument: String, reason: String, cause: Throwable? = null) : AiSdkException

InvalidDataContentError

class InvalidDataContentError(val content: Any?, cause: Throwable? = null, message: String = "Invalid data content. Expected a base64 string, ByteArray, or platform byte buffer, " + "but got ${content?.let { it::class.simpleName } ?: "null"}.") : AiSdkException

InvalidMessageRoleError

class InvalidMessageRoleError(val role: String, message: String = "Invalid message role: '") : AiSdkException

InvalidPromptError

class InvalidPromptError(val prompt: Any?, message: String, cause: Throwable? = null) : AiSdkException

InvalidResponseDataError

class InvalidResponseDataError(val data: Any?, message: String = "Invalid response data: ") : AiSdkException

InvalidStreamPartError

class InvalidStreamPartError(val chunk: Any?, message: String) : AiSdkException

InvalidToolApprovalError

class InvalidToolApprovalError(val approvalId: String) : AiSdkException

InvalidToolInputError

class InvalidToolInputError(val toolInput: String, val toolName: String, cause: Throwable, message: String = "Invalid input for tool ") : AiSdkException

JSONParseError

class JSONParseError(val text: String, cause: Throwable) : AiSdkException

JSONRPCError

@Serializable

data class JSONRPCError(val id: JsonElement, val error: JSONRPCErrorData, val jsonrpc: String = JSONRPC_VERSION) : JSONRPCMessage

JSONRPCErrorData

@Serializable

data class JSONRPCErrorData(val code: Int, val message: String, val data: JsonElement? = null)

JSONRPCMessage

@Serializable

sealed interface JSONRPCMessage

JSONRPCNotification

@Serializable

data class JSONRPCNotification(val method: String, val params: JsonObject? = null, val jsonrpc: String = JSONRPC_VERSION) : JSONRPCMessage

JSONRPCRequest

@Serializable

data class JSONRPCRequest(val id: JsonElement, val method: String, val params: JsonObject? = null, val jsonrpc: String = JSONRPC_VERSION) : JSONRPCMessage

JSONRPCResponse

@Serializable

data class JSONRPCResponse(val id: JsonElement, val result: JsonElement = JsonObject(emptyMap()), val jsonrpc: String = JSONRPC_VERSION) : JSONRPCMessage

KtorGatewayTransport

class KtorGatewayTransport(client: HttpClient, json: Json = aiSdkJson) : GatewayTransport

LangChainBaseMessage

@Serializable

data class LangChainBaseMessage(val role: LangChainMessageRole, val content: JsonElement = JsonPrimitive(""), val id: String? = null, val toolCallId: String? = null, val toolCalls: List<LangChainToolCall> = emptyList(), val additionalKwargs: Map<String, JsonElement> = emptyMap())

LangChainMessageRole

@Serializable

enum LangChainMessageRole : Enum<LangChainMessageRole>

LangChainStreamItem

sealed interface LangChainStreamItem

LangChainToolCall

@Serializable

data class LangChainToolCall(val id: String, val name: String, val input: JsonElement = JsonObject(emptyMap()))

LangSmithDeploymentTransport

class LangSmithDeploymentTransport(options: LangSmithDeploymentTransportOptions, graphStream: LangSmithGraphStream = { _, _ -> throw UnsupportedOperationException( "LangSmithDeploymentTransport requires a graphStream implementation in Kotlin Multiplatform.", ) }) : ChatTransport

LangSmithDeploymentTransportOptions

data class LangSmithDeploymentTransportOptions(val url: String, val apiKey: String? = null, val graphId: String = "agent", val headers: Map<String, String> = emptyMap())

LangSmithGraphStream

typealias LangSmithGraphStream = suspend (messages: List<LangChainBaseMessage>, options: LangSmithDeploymentTransportOptions) -> Flow<LangChainStreamItem>

LanguageModel

interface LanguageModel

Provider-neutral model surface. Per invariant I-4 / I-9, application code never depends on a specific provider — it depends on this interface, and provider-specific differences live in middleware (see LanguageModelMiddleware).

LanguageModelCallParams

data class LanguageModelCallParams(val messages: List<ModelMessage>, val tools: List<LanguageModelTool> = emptyList(), val toolChoice: ToolChoice = ToolChoice.Auto, val temperature: Float? = null, val topP: Float? = null, val topK: Int? = null, val maxOutputTokens: Int? = null, val stopSequences: List<String> = emptyList(), val seed: Int? = null, val providerOptions: Map<String, JsonElement> = emptyMap(), val abortSignal: AbortSignal = AbortSignalNever, val presencePenalty: Float? = null, val frequencyPenalty: Float? = null, val responseFormat: ResponseFormat = ResponseFormat.Text, val headers: Map<String, String> = emptyMap())

Single parameter envelope for both generate and stream so middleware can wrap both the same way and wrapLanguageModel only needs one pass-through shape.

LanguageModelMiddleware

interface LanguageModelMiddleware

Provider middleware. Per invariants I-9 and R-11, provider differences (Anthropic-specific options, OpenAI-specific options, on-device-only sampling knobs) live in middleware — NEVER in agent or orchestration code. If you find yourself branching on model.modelId.startsWith("...") inside an agent, that's a missing middleware.

LanguageModelRequestMetadata

data class LanguageModelRequestMetadata(val body: JsonElement? = null)

Request metadata recorded by HTTP-backed or gateway providers.

LanguageModelResponseMetadata

data class LanguageModelResponseMetadata(val id: String? = null, val timestampMillis: Long? = null, val modelId: String? = null, val headers: Map<String, String> = emptyMap(), val body: JsonElement? = null, val messages: List<ModelMessage> = emptyList())

Response metadata recorded by HTTP-backed or gateway providers.

LanguageModelResult

data class LanguageModelResult(val text: String, val toolCalls: List<ContentPart.ToolCall> = emptyList(), val finishReason: FinishReason, val usage: Usage, val providerMetadata: Map<String, JsonElement> = emptyMap(), val content: List<ContentPart> = buildList { if (text.isNotEmpty()) add(ContentPart.Text(text)) addAll(toolCalls) }, val rawFinishReason: String? = null, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata())

One-shot generate result.

LanguageModelStreamResult

data class LanguageModelStreamResult(val stream: Flow<StreamEvent>, val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata())

Provider stream plus request/response metadata known before collection.

LanguageModelTool

data class LanguageModelTool(val name: String, val description: String, val parametersSchemaJson: String, val providerExecuted: Boolean = false, val metadata: Map<String, JsonElement> = emptyMap(), val strict: Boolean = true, val providerOptions: Map<String, JsonElement> = emptyMap())

Tool advertisement at the model surface — the JSON-schema shape the provider needs. Distinct from the application-side Tool which carries a Kotlin executor; this is the wire shape that crosses into a provider.

LazySchema

class LazySchema<T>(createSchema: () -> Schema<T>)

ListPromptsResult

@Serializable

data class ListPromptsResult(val prompts: List<MCPPrompt>, val nextCursor: String? = null, val meta: JsonObject? = null)

ListResourcesResult

@Serializable

data class ListResourcesResult(val resources: List<MCPResource>, val nextCursor: String? = null, val meta: JsonObject? = null)

ListResourceTemplatesResult

@Serializable

data class ListResourceTemplatesResult(val resourceTemplates: List<MCPResourceTemplate>, val nextCursor: String? = null, val meta: JsonObject? = null)

ListToolsResult

@Serializable

data class ListToolsResult(val tools: List<MCPToolDefinition>, val nextCursor: String? = null, val meta: JsonObject? = null)

LlamaIndexEngineResponse

data class LlamaIndexEngineResponse(val delta: String)

LoadAPIKeyError

class LoadAPIKeyError(message: String) : AiSdkException

LoadSettingError

class LoadSettingError(message: String) : AiSdkException

Logger

interface Logger

Port-side log sink for non-fatal warnings and informational events. Mirrors v6's logger/log-warnings.ts (per historical parity gap #31) — the agent loop, middleware, and tool dispatch surface warnings here so consumers can route them to Logcat / Crashlytics / their own telemetry without the port hard-coding a logging dependency.

LoopState

data class LoopState(val stepNumber: Int, val totalSteps: Int, val lastFinishReason: FinishReason, val toolCallsThisStep: List<ContentPart.ToolCall>, val toolCallsAllSteps: List<ContentPart.ToolCall>, val steps: List<StepResult> = emptyList())

MCPBaseParams

@Serializable

data class MCPBaseParams(val meta: JsonObject? = null)

MCPClient

interface MCPClient

MCPClientCapabilities

@Serializable

data class MCPClientCapabilities(val elicitation: ElicitationCapability? = null, val experimental: JsonObject? = null)

MCPClientConfig

data class MCPClientConfig(val transport: MCPTransport, val onUncaughtError: (Throwable) -> Unit? = null, val clientName: String? = null, val name: String? = null, val version: String = DEFAULT_MCP_CLIENT_VERSION, val capabilities: MCPClientCapabilities = MCPClientCapabilities())

MCPClientError

class MCPClientError(message: String, val code: Int? = null, val data: JsonElement? = null, cause: Throwable? = null) : AiSdkException

MCPPrompt

@Serializable

data class MCPPrompt(val name: String, val title: String? = null, val description: String? = null, val arguments: List<MCPPromptArgument>? = null)

MCPPromptArgument

@Serializable

data class MCPPromptArgument(val name: String, val description: String? = null, val required: Boolean? = null)

MCPPromptMessage

@Serializable

data class MCPPromptMessage(val role: String, val content: JsonObject)

MCPRequestOptions

data class MCPRequestOptions(val signal: AbortSignal? = null, val timeoutMillis: Long? = null, val maxTotalTimeoutMillis: Long? = null)

MCPResource

@Serializable

data class MCPResource(val uri: String, val name: String, val title: String? = null, val description: String? = null, val mimeType: String? = null, val size: Long? = null)

MCPResourceTemplate

@Serializable

data class MCPResourceTemplate(val uriTemplate: String, val name: String, val title: String? = null, val description: String? = null, val mimeType: String? = null)

MCPServerCapabilities

@Serializable

data class MCPServerCapabilities(val experimental: JsonObject? = null, val logging: JsonObject? = null, val prompts: JsonObject? = null, val resources: JsonObject? = null, val tools: JsonObject? = null, val elicitation: ElicitationCapability? = null)

MCPToolDefinition

@Serializable

data class MCPToolDefinition(val name: String, val title: String? = null, val description: String? = null, val inputSchema: JsonObject = JsonObject(mapOf("type" to JsonPrimitive("object"))), val outputSchema: JsonObject? = null, val annotations: JsonObject? = null, val meta: JsonObject? = null)

MCPToolSchema

@Serializable

data class MCPToolSchema(val inputSchema: JsonElement, val outputSchema: JsonElement? = null)

MCPToolSchemas

typealias MCPToolSchemas = Map<String, MCPToolSchema>

MCPTransport

interface MCPTransport

Transport interface for MCP communication. Implementations may wrap stdio, Streamable HTTP, SSE, WebSockets, or a test fixture.

MCPTransportConfig

data class MCPTransportConfig(val type: MCPTransportKind, val url: String, val headers: Map<String, String> = emptyMap(), val authProvider: OAuthClientProvider? = null, val engineContext: CoroutineContext = Dispatchers.Default)

MCPTransportKind

enum MCPTransportKind : Enum<MCPTransportKind>

MessageConversionError

class MessageConversionError(val originalMessage: Any?, message: String) : AiSdkException

MessageRole

@Serializable

enum MessageRole : Enum<MessageRole>

MiddlewareCallContext

data class MiddlewareCallContext(val params: LanguageModelCallParams, val model: LanguageModel, val doGenerate: suspend (LanguageModelCallParams) -> LanguageModelResult, val doStream: (LanguageModelCallParams) -> Flow<StreamEvent>)

What a middleware receives. Contains:

MiddlewareOperation

enum MiddlewareOperation : Enum<MiddlewareOperation>

Which operation a LanguageModelMiddleware.transformParams call is transforming.

MissingToolResultsError

class MissingToolResultsError(val toolCallIds: List<String>) : AiSdkException

ModelId

@JvmInline

value class ModelId(val value: String)

ModelMessage

@Serializable

data class ModelMessage(val role: MessageRole, val content: List<ContentPart>)

v6 wire-shape message — the type passed to LanguageModel generations. Renamed from CoreMessage (v5) per the AI SDK v6 migration.

ModelRef

data class ModelRef(val modelId: ModelId, val providerId: ProviderId? = null)

MutableTelemetrySpan

class MutableTelemetrySpan(val name: String, mutableAttributes: MutableMap<String, JsonElement> = linkedMapOf()) : TelemetryActiveSpan

NoContentGeneratedError

class NoContentGeneratedError(message: String = "No content generated.") : AiSdkException

NoImageGeneratedError

class NoImageGeneratedError(message: String = "No image generated", val responses: List<LanguageModelResponseMetadata> = emptyList(), cause: Throwable? = null) : AiSdkException

NoObjectGeneratedError

class NoObjectGeneratedError(message: String = "No object generated", val text: String? = null, val response: LanguageModelResponseMetadata? = null, val usage: Usage? = null, val finishReason: FinishReason? = null, cause: Throwable? = null) : AiSdkException

Thrown when no object could be generated (the model failed, or its output could not be parsed/validated). Carries the diagnostic context upstream's NoObjectGeneratedError exposes so callers can inspect the raw text, the response metadata, the token usage, and the finish reason of the failed call.

NoopLogger

data object NoopLogger : Logger

Drop-everything logger. Default when no DI-injected impl is wired.

NoopTelemetryTracer

data object NoopTelemetryTracer : TelemetryTracer

NoopToolStreamWriter

data object NoopToolStreamWriter : ToolStreamWriter

No-op ToolStreamWriter — the default on a ToolExecutionContext constructed outside the loop (test fixtures, the approval-resume path before the loop wires a real writer). Drops every write.

NoOutputGeneratedError

class NoOutputGeneratedError(message: String = "No output generated") : AiSdkException

NoSpeechGeneratedError

class NoSpeechGeneratedError(message: String = "No speech generated", val responses: List<LanguageModelResponseMetadata> = emptyList(), cause: Throwable? = null) : AiSdkException

NoSuchModelError

class NoSuchModelError(providerId: String?, modelType: String, modelId: String, message: String = buildString { append("No ") append(modelType) append(" model registered for `") providerId?.let { append(it).append(":") } append(modelId) append("`") }) : AiSdkException

NoSuchProviderError

class NoSuchProviderError(val providerId: String, val availableProviders: List<String> = emptyList()) : AiSdkException

NoSuchToolError

class NoSuchToolError(val toolName: String, val availableTools: List<String>? = null, message: String = "Model tried to call unavailable tool '$toolName'. " + if (availableTools == null) { "No tools are available." } else { "Available tools: ${availableTools.joinToString(", ")}." }) : AiSdkException

NoTranscriptGeneratedError

class NoTranscriptGeneratedError(message: String = "No transcript generated", val responses: List<LanguageModelResponseMetadata> = emptyList(), cause: Throwable? = null) : AiSdkException

NoVideoGeneratedError

class NoVideoGeneratedError(message: String = "No video generated", val responses: List<LanguageModelResponseMetadata> = emptyList(), cause: Throwable? = null) : AiSdkException

OAuthClientInformation

@Serializable

data class OAuthClientInformation(val clientId: String, val clientSecret: String? = null, val clientIdIssuedAt: Long? = null, val clientSecretExpiresAt: Long? = null)

OAuthClientMetadata

@Serializable

data class OAuthClientMetadata(val redirectUris: List<String>, val tokenEndpointAuthMethod: String? = null, val grantTypes: List<String>? = null, val responseTypes: List<String>? = null, val clientName: String? = null, val clientUri: String? = null, val logoUri: String? = null, val scope: String? = null, val contacts: List<String>? = null, val tosUri: String? = null, val policyUri: String? = null, val jwksUri: String? = null, val jwks: JsonElement? = null, val softwareId: String? = null, val softwareVersion: String? = null, val softwareStatement: String? = null)

OAuthClientProvider

interface OAuthClientProvider

OAuthProtectedResourceMetadata

@Serializable

data class OAuthProtectedResourceMetadata(val resource: String, val authorizationServers: List<String>? = null, val jwksUri: String? = null, val scopesSupported: List<String>? = null, val bearerMethodsSupported: List<String>? = null, val resourceName: String? = null)

OAuthTokens

@Serializable

data class OAuthTokens(val accessToken: String, val tokenType: String, val idToken: String? = null, val expiresIn: Long? = null, val scope: String? = null, val refreshToken: String? = null)

OnAbortEvent

data class OnAbortEvent(val steps: List<StepResult>)

Fired when generation is aborted via AbortSignal before it finishes. Carries the steps completed up to the abort. Mirrors upstream's onAbort({ steps }).

OnChunkEvent

data class OnChunkEvent(val event: StreamEvent, val stepNumber: Int)

Each individual stream chunk, alongside the step it belongs to.

OnErrorEvent

data class OnErrorEvent(val error: Throwable, val stepNumber: Int, val source: OnErrorEvent.ErrorSource)

OnFinishEvent

data class OnFinishEvent(val finalOutput: Any?, val totalSteps: Int, val usage: Usage, val pendingApprovals: List<PendingApproval> = emptyList(), val messages: List<ModelMessage> = emptyList(), val experimental_context: Any? = null)

OnStartEvent

data class OnStartEvent(val prompt: String?, val priorMessages: List<ModelMessage>, val options: Any?)

Lifecycle hook event types (best practice #10). Hooks are observation points — they do NOT modify behavior. If a hook needs to influence the loop, the right place is PrepareStepScope / PrepareCallScope.

OnStepFinishEvent

data class OnStepFinishEvent(val stepNumber: Int, val step: StepResult)

OnStepStartEvent

data class OnStepStartEvent(val stepNumber: Int, val messages: List<ModelMessage>, val request: LanguageModelCallParams? = null, val priorSteps: List<StepResult> = emptyList())

Fired before each loop step's model call. Per historical parity gap #35, the payload was extended from (stepNumber, messages) to carry the full prepared request (post prepareCall + prepareStep overrides) plus accumulated priorSteps so observers can:

OnToolCallFinishEvent

data class OnToolCallFinishEvent(val toolCallId: String, val toolName: String, val outputJson: JsonElement?, val errorMessage: String?, val stepNumber: Int)

Fired immediately after a tool's executor returns or throws. Exactly one of outputJson or errorMessage is non-null.

OnToolCallStartEvent

data class OnToolCallStartEvent(val toolCallId: String, val toolName: String, val input: JsonElement, val stepNumber: Int, val messages: List<ModelMessage>)

Fired immediately before a tool's executor runs. Carries the parsed tool call envelope and the messages-list snapshot so observers can record context (e.g. for tracing).

Output

sealed class Output<T>

Structured output for generateText / streamText / Agent.

ParseResult

sealed interface ParseResult<out T>

PartialJsonResult

data class PartialJsonResult(val value: JsonElement?, val state: PartialJsonState)

Result of parsePartialJson: value is non-null only on the two success states.

PartialJsonState

enum PartialJsonState : Enum<PartialJsonState>

Outcome of parsePartialJson, mirroring v6's four state strings.

PendingApproval

@Serializable

data class PendingApproval(val toolCallId: String, val toolName: String, val input: JsonElement, val approvalId: String? = null, val signature: String? = null)

A pending tool-call approval surfaced from Agent.generate / Agent.stream. Per v6 RPC semantics, generation completes when one or more tools require approval — the host inspects GenerateResult.pendingApprovals, presents UI, and resumes by calling Agent.generate again with messages = result.messages + toolApprovalResponseMessage(...).

PrepareCallScope

class PrepareCallScope<TContext>(val options: TContext?, val instructions: String, val model: LanguageModel, val tools: ToolSet<TContext>)

Scope for prepareCall, run once before the loop starts. Useful for RAG context injection, per-user customization, database lookups that shouldn't repeat per step.

PrepareStepScope

class PrepareStepScope<TContext>(val stepNumber: Int, val model: LanguageModel, val steps: List<StepResult>, val messages: List<ModelMessage>, val context: TContext?)

Scope for prepareStep, run before every step in the loop. Used for: model routing per step (cheap model for step 1 + 2, expensive for step 3), tool gating per step (only the search tool is callable on step 1), dynamic system prompts, message compression.

Provider

interface Provider

ProviderId

@JvmInline

value class ProviderId(val value: String)

ProviderMiddleware

data class ProviderMiddleware(val languageModelMiddlewares: List<LanguageModelMiddleware> = emptyList(), val embeddingModelMiddlewares: List<EmbeddingModelMiddleware> = emptyList(), val imageModelMiddlewares: List<ImageModelMiddleware> = emptyList())

ProviderOptionsBuilder

class ProviderOptionsBuilder

ProviderRegistry

class ProviderRegistry(providers: Map<String, Provider>, defaultProviderId: String? = null, separator: String = ":", languageModelMiddleware: List<LanguageModelMiddleware> = emptyList()) : Provider

ProviderToolFactory

class ProviderToolFactory<TInput, TContext>(id: String, inputSerializer: KSerializer<TInput>, inputSchema: Schema<TInput>, defaultDescription: String = "Provider tool ")

ProviderToolFactoryOptions

data class ProviderToolFactoryOptions<TInput, TOutput, TContext>(val outputSerializer: KSerializer<TOutput>, val outputSchema: Schema<TOutput>? = null, val args: Map<String, JsonElement> = emptyMap(), val name: String? = null, val description: String? = null, val metadata: Map<String, JsonElement> = emptyMap(), val execute: suspend ToolExecutionContext<TContext>.(TInput) -> TOutput? = null, val needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, val toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, val onInputStart: suspend (streamingId: String) -> Unit? = null, val onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, val onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null)

ProviderToolFactoryWithOutputSchema

class ProviderToolFactoryWithOutputSchema<TInput, TOutput, TContext>(id: String, inputSerializer: KSerializer<TInput>, inputSchema: Schema<TInput>, outputSerializer: KSerializer<TOutput>, outputSchema: Schema<TOutput>, supportsDeferredResults: Boolean = false, defaultDescription: String = "Provider tool ")

PruneEmptyMessages

enum PruneEmptyMessages : Enum<PruneEmptyMessages>

PruneReasoning

enum PruneReasoning : Enum<PruneReasoning>

PruneToolCallRule

data class PruneToolCallRule(val type: PruneToolCallRuleType, val tools: Set<String>? = null)

PruneToolCallRuleType

sealed class PruneToolCallRuleType

PruneToolCalls

sealed class PruneToolCalls

ReadResourceResult

@Serializable

data class ReadResourceResult(val contents: List<JsonObject>, val meta: JsonObject? = null)

RerankedItem

data class RerankedItem<T>(val value: T, val score: Float, val index: Int)

RerankingModel

interface RerankingModel

RerankingModelResult

data class RerankingModelResult(val results: List<RerankedItem<String>>, val usage: Usage = Usage(), val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap())

RerankingParams

data class RerankingParams(val query: String, val documents: List<String>, val topN: Int? = null, val providerOptions: Map<String, JsonElement> = emptyMap(), val headers: Map<String, String> = emptyMap(), val abortSignal: AbortSignal = AbortSignalNever)

RerankResult

data class RerankResult<T>(val results: List<RerankedItem<T>>, val originalDocuments: List<T> = emptyList(), val usage: Usage = Usage(), val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap())

ResponseFormat

@Serializable

sealed interface ResponseFormat

Wire-level constraint on what shape the model is allowed to emit. Mirrors v6's responseFormat (per call-settings.ts:103-128 → historical parity gap #20). Distinct from Output — Output is the post-decode wrapper that turns text into typed values; ResponseFormat is what the provider sees at call time.

RetryError

class RetryError(message: String, val reason: RetryErrorReason, val errors: List<Throwable>) : AiSdkException

RetryErrorReason

enum RetryErrorReason : Enum<RetryErrorReason>

RetryPolicy

data class RetryPolicy(val maxRetries: Int = 2, val baseDelayMs: Long = 100, val maxDelayMs: Long)

Schema

data class Schema<T>(val jsonSchema: JsonElement, val validate: (JsonElement) -> T? = null)

SpeechGenerationParams

data class SpeechGenerationParams(val text: String, val voice: String? = null, val instructions: String? = null, val speed: Float? = null, val responseFormat: String? = null, val language: String? = null, val providerOptions: Map<String, JsonElement> = emptyMap(), val headers: Map<String, String> = emptyMap(), val abortSignal: AbortSignal = AbortSignalNever)

SpeechModel

interface SpeechModel

SpeechModelResult

data class SpeechModelResult(val audio: GeneratedFile?, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap())

SseMCPTransport

class SseMCPTransport(client: HttpClient, url: String, headers: Map<String, String> = emptyMap(), authProvider: OAuthClientProvider? = null, engineContext: CoroutineContext = Dispatchers.Default) : MCPTransport

StdioConfig

@Serializable

data class StdioConfig(val command: String, val args: List<String> = emptyList(), val env: Map<String, String> = emptyMap(), val cwd: String? = null)

StepResult

data class StepResult(val stepNumber: Int, val text: String, val reasoning: String, val toolCalls: List<ContentPart.ToolCall>, val toolResults: List<ContentPart.ToolResult>, val toolApprovalRequests: List<ContentPart.ToolApprovalRequest>, val finishReason: FinishReason, val usage: Usage, val warnings: List<CallWarning> = emptyList(), val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap(), val rawFinishReason: String? = null, val model: String? = null, val experimentalContext: Any? = null)

Snapshot of one completed loop step — surfaced to OnStepFinishEvent and accumulated in the loop state for PrepareStepScope.steps.

StepSettings

data class StepSettings<TContext>(val model: LanguageModel? = null, val activeTools: List<String>? = null, val toolChoice: ToolChoice? = null, val messages: List<ModelMessage>? = null, val system: String? = null, val providerOptions: Map<String, JsonElement>? = null, val temperature: Float? = null, val topP: Float? = null, val topK: Int? = null, val maxOutputTokens: Int? = null, val stopSequences: List<String>? = null, val seed: Int? = null, val presencePenalty: Float? = null, val frequencyPenalty: Float? = null, val responseFormat: ResponseFormat? = null, val experimental_context: TContext? = null)

Returned from prepareStep. Any non-null field overrides the agent default / prepareCall value for this step only.

StopCondition

fun interface StopCondition

First-class loop stop conditions (invariant I-7). The SDK manages the loop; consumers express completion as a StopCondition passed to the agent constructor or generateText.

StreamCallbacks

data class StreamCallbacks(val onStart: suspend () -> Unit? = null, val onFinal: suspend (completion: String) -> Unit? = null, val onToken: suspend (token: String) -> Unit? = null, val onText: suspend (text: String) -> Unit? = null, val onFinish: suspend (finalState: JsonElement?) -> Unit? = null, val onError: suspend (error: Throwable) -> Unit? = null, val onAbort: suspend () -> Unit? = null)

StreamEvent

@Serializable

sealed interface StreamEvent

Sealed event stream emitted by LanguageModel.stream and surfaced to application code via Agent.stream. Mirrors the v6 stream-part taxonomy (per packages/ai/src/generate-text/stream-text-result.ts in vercel/ai) adapted to Kotlin sealed classes for exhaustive when.

StreamObjectFinish

data class StreamObjectFinish<TOutput>(val value: TOutput, val usage: Usage, val finishReason: FinishReason, val warnings: List<CallWarning>, val response: LanguageModelResponseMetadata)

The final object plus terminal metadata of a StreamObjectResult.finish.

StreamObjectResult

class StreamObjectResult<TOutput>

A typed streaming-object result — the v6 StreamObjectResult surface. Wraps the underlying StreamEvent flow so callers get the object as it builds and the final typed value, without hand-parsing the stream.

StreamTextResult

class StreamTextResult(sourceStream: Flow<StreamEvent>, val request: LanguageModelRequestMetadata = LanguageModelRequestMetadata(), initialResponse: LanguageModelResponseMetadata = LanguageModelResponseMetadata())

StructuredObject

class StructuredObject<RESULT, INPUT>(options: StructuredObjectOptions<RESULT, INPUT>)

StructuredObjectFinish

data class StructuredObjectFinish<RESULT>(val value: RESULT?, val error: Throwable?, val rawValue: JsonElement?)

StructuredObjectOptions

data class StructuredObjectOptions<RESULT, INPUT>(val api: String, val schema: Schema<RESULT>, val id: String = generateId("object"), val initialValue: RESULT? = null, val headers: Map<String, String> = emptyMap(), val transport: StructuredObjectTransport<INPUT> = DirectStructuredObjectTransport { emptyFlow() }, val onFinish: suspend (StructuredObjectFinish<RESULT>) -> Unit = {}, val onError: suspend (Throwable) -> Unit = {})

StructuredObjectRequest

data class StructuredObjectRequest<INPUT>(val api: String, val id: String, val input: INPUT, val headers: Map<String, String> = emptyMap(), val abortSignal: AbortSignal = AbortSignalNever)

StructuredObjectTransport

interface StructuredObjectTransport<INPUT>

Telemetry

interface Telemetry

The v7 telemetry integration seam (upstream's Telemetry, the revamped TelemetryIntegration): implement it ONCE and the loop feeds it every lifecycle event of every invocation — agent start/finish, step start/finish, model-call start/finish, tool-call start/finish (including tool executions resumed after an approval pause), errors, and aborts. Upstream: "Instead of wiring up individual callbacks on every call, you implement a Telemetry once and register it globally or pass it via telemetry.integrations."

TelemetryActiveSpan

interface TelemetryActiveSpan

TelemetryCall

data class TelemetryCall(val callId: String, val agentId: String, val agentVersion: String? = null, val modelId: String? = null, val functionId: String? = null)

Correlation envelope for one agent invocation (one generate/stream call). Every Telemetry event of that invocation carries the same callId, so an integration can reconstruct per-call traces even when a single agent instance serves concurrent calls. agentId/agentVersion mirror Agent.id/Agent.version (parity gap #33: "useful for telemetry"); functionId comes from TelemetrySettings.functionId.

TelemetryModelCallEvent

data class TelemetryModelCallEvent(val stepNumber: Int, val modelId: String?, val params: LanguageModelCallParams)

Fired before one step's model call — carries the EXACT prepared params sent to the provider.

TelemetryModelCallResultEvent

data class TelemetryModelCallResultEvent(val stepNumber: Int, val modelId: String?, val finishReason: FinishReason, val usage: Usage, val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val rawFinishReason: String? = null)

Fired after one step's model call streamed to completion.

TelemetryRegistry

class TelemetryRegistry(seed: List<Telemetry> = emptyList())

Ordered registry of Telemetry integrations, keyed by Telemetry.name (re-register replaces, keeping the original position).

TelemetrySettings

data class TelemetrySettings(val isEnabled: Boolean? = null, val functionId: String? = null, val metadata: Map<String, JsonElement> = emptyMap(), val recordInputs: Boolean = true, val recordOutputs: Boolean = true, val integrations: List<Telemetry> = emptyList(), val tracer: TelemetryTracer? = null)

Telemetry settings for an agent or call (upstream v7 telemetry, the stabilized experimental_telemetry). With the v7 revamp, telemetry is opt-out: once an integration is registered via registerTelemetry, every agent invocation emits events to it automatically.

TelemetrySpanEvent

data class TelemetrySpanEvent(val name: String, val attributes: Map<String, JsonElement> = emptyMap())

TelemetrySpanStatus

sealed interface TelemetrySpanStatus

TelemetryTracer

interface TelemetryTracer

TextGenerationRequest

data class TextGenerationRequest(val prompt: String? = null, val messages: List<ModelMessage> = emptyList(), val system: String? = null, val settings: CallSettings = CallSettings())

TextGenerationRequestBuilder

class TextGenerationRequestBuilder

Tool

class Tool<TInput, TOutput, TContext>(val name: String, val description: String, val inputSerializer: KSerializer<TInput>, val outputSerializer: KSerializer<TOutput>, val executor: ToolExecutionContext<TContext>.(TInput) -> Flow<TOutput>, val needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, val toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, val strict: Boolean = true, val inputExamples: List<String> = emptyList(), val onInputStart: suspend (streamingId: String) -> Unit? = null, val onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, val onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null, val metadata: Map<String, JsonElement> = emptyMap(), val providerExecuted: Boolean = false, val providerOptions: Map<String, JsonElement> = emptyMap())

A tool the LLM can call — application code constructs these via the top-level tool (single-value) or streamingTool (Flow) factories.

ToolCallNotFoundForApprovalError

class ToolCallNotFoundForApprovalError(val toolCallId: String, val approvalId: String) : AiSdkException

ToolCallRepairError

class ToolCallRepairError(val originalError: Throwable, cause: Throwable, message: String = "Error repairing tool call: ") : AiSdkException

ToolCallRepairFunction

typealias ToolCallRepairFunction<TContext> = suspend (failedCall: ContentPart.ToolCall, error: Throwable, messages: List<ModelMessage>, tools: ToolSet<TContext>) -> ContentPart.ToolCall?

Callback invoked when a tool call's JSON arguments fail to decode (the model emitted JSON that doesn't match the tool's input schema, or referenced an unknown tool). Return a corrected ContentPart.ToolCall to retry execution, or null to give up (the loop emits StreamEvent.ToolError for this call).

ToolChoice

@Serializable

sealed interface ToolChoice

Whether the LLM should call a tool, no tool, a specific tool, etc.

ToolExecutionContext

class ToolExecutionContext<TContext>(val context: TContext?, val abortSignal: AbortSignal, val stepNumber: Int, val messages: List<ModelMessage>, val toolCallId: String, val writer: ToolStreamWriter = NoopToolStreamWriter)

What Tool.executor sees as this. Holds the typed application context (whatever the agent's callOptionsSchema says) plus the abort signal (invariant I-10: subagent tool handlers MUST forward this), the current step number, and the running message list.

ToolLoopAgent

abstract class ToolLoopAgent<TContext, TOutput>(val model: LanguageModel, val instructions: String, val tools: ToolSet<TContext>, val activeTools: List<String>? = null, val output: Output<TOutput>? = null, val stopWhen: StopCondition = stepCountIs(20), val prepareCall: suspend PrepareCallScope<TContext>.() -> AgentSettings<TContext>? = null, val prepareStep: suspend PrepareStepScope<TContext>.() -> StepSettings<TContext>? = null, val callOptionsSchema: KSerializer<TContext>? = null, val temperature: Float? = null, val topP: Float? = null, val topK: Int? = null, val maxOutputTokens: Int? = null, val stopSequences: List<String>? = null, val seed: Int? = null, val presencePenalty: Float? = null, val frequencyPenalty: Float? = null, val responseFormat: ResponseFormat = ResponseFormat.Text, val maxParallelToolCalls: Int = Int.MAX_VALUE, val onStart: suspend OnStartEvent.() -> Unit? = null, val onStepStart: suspend OnStepStartEvent.() -> Unit? = null, val onStepFinish: suspend OnStepFinishEvent.() -> Unit? = null, val onFinish: suspend OnFinishEvent.() -> Unit? = null, val onError: suspend OnErrorEvent.() -> Unit? = null, val onChunk: suspend OnChunkEvent.() -> Unit? = null, val onAbort: suspend OnAbortEvent.() -> Unit? = null, val experimental_onToolCallStart: suspend OnToolCallStartEvent.() -> Unit? = null, val experimental_onToolCallFinish: suspend OnToolCallFinishEvent.() -> Unit? = null, val experimental_repairToolCall: ToolCallRepairFunction<TContext>? = null, val experimental_toolApprovalSecret: ByteArray? = null, val telemetry: TelemetrySettings? = null, val logger: Logger = NoopLogger, engineContext: CoroutineContext = Dispatchers.Default) : Agent<TContext, TOutput>

Abstract base Agent implementation — the canonical v6 ToolLoopAgent. Extend it; do not instantiate it. A concrete agent subclasses this (e.g. class MyAgent(...) : ToolLoopAgent<C, O>(...)) so the agent's identity, tools, lifecycle overrides, and DI live in one named type — never a bare ToolLoopAgent(...) held as a field.

ToolLoopAgentAction

sealed interface ToolLoopAgentAction<out TContext>

Actions the host dispatches to drive the agent. Mirrors the Action sealed type a Compose ViewModel exposes — the agent is the "model" of an MVI loop.

ToolLoopAgentState

data class ToolLoopAgentState(val messages: List<ModelMessage> = emptyList(), val streamingAssistantText: String = "", val currentToolCalls: List<ContentPart.ToolCall> = emptyList(), val pendingApprovals: List<PendingApproval> = emptyList(), val isStreaming: Boolean = false, val isModelLoading: Boolean = false, val error: String? = null, val totalSteps: Int = 0, val lastFinishReason: FinishReason? = null)

Engine-shape state for ToolLoopAgent.

ToolNameMapping

data class ToolNameMapping(customToolNameToProviderToolName: Map<String, String>, providerToolNameToCustomToolName: Map<String, String>)

ToolPredicateOptions

data class ToolPredicateOptions<TContext>(val toolCallId: String, val messages: List<ModelMessage>, val experimental_context: TContext? = null)

Options bag passed to predicate callbacks (Tool.needsApproval, Tool.toModelOutput). Mirrors v6's {toolCallId, messages, experimental_context} argument shape (per historical parity gap #17). Lets a predicate decide based on the conversation history or the current call's identity, not just the input.

ToolResultOutput

@Serializable

sealed class ToolResultOutput

Structured return type for Tool.toModelOutput. Replaces the flat String return per historical parity gap #14. Lets a tool supply EITHER a short plain-text summary OR a structured JSON payload OR a typed error to the model — the agent's loop bridges each into the wire-format ContentPart.ToolResult.modelVisible appropriately:

ToolSet

class ToolSet<TContext>(val byName: Map<String, Tool<*, *, TContext>>)

Erased map of tools indexed by name — what the agent loop actually carries. Application code constructs via toolSetOf.

ToolSetBuilder

class ToolSetBuilder<TContext>

ToolStreamWriter

interface ToolStreamWriter

Lets a tool's executor write custom events into the agent's active output stream — the port's equivalent of v6's UIMessageStreamWriter (per historical parity gap #21). Distinct from the streamingTool mechanism (which surfaces progress as ToolResult(preliminary = true)): the writer pushes ARBITRARY StreamEvents — e.g. a transient status line (StreamEvent.TextDelta) or a custom data payload (StreamEvent.Raw via writeData) — that don't have to be tool-result-shaped. Writes interleave with the tool's own emissions in stream order. streamToUiMessages ignores Raw by default, so a consumer that wants custom data intercepts the Flow<StreamEvent> before UI conversion.

TooManyEmbeddingValuesForCallError

class TooManyEmbeddingValuesForCallError(val provider: String, val modelId: String, val maxEmbeddingsPerCall: Int, val values: List<Any?>) : AiSdkException

TranscribeResult

data class TranscribeResult(val text: String, val segments: List<TranscriptSegment> = emptyList(), val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap(), val responses: List<LanguageModelResponseMetadata> = listOf(response), val language: String? = null, val durationInSeconds: Float? = null)

TranscriptionModel

interface TranscriptionModel

TranscriptionModelResult

data class TranscriptionModelResult(val text: String?, val segments: List<TranscriptSegment> = emptyList(), val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap(), val language: String? = null, val durationInSeconds: Float? = null)

TranscriptionParams

data class TranscriptionParams(val audio: AudioSource, val language: String? = null, val prompt: String? = null, val providerOptions: Map<String, JsonElement> = emptyMap(), val headers: Map<String, String> = emptyMap(), val abortSignal: AbortSignal = AbortSignalNever)

TranscriptSegment

data class TranscriptSegment(val text: String, val startSeconds: Float? = null, val endSeconds: Float? = null)

TypeValidationContext

data class TypeValidationContext(val field: String? = null, val entityName: String? = null, val entityId: String? = null)

TypeValidationError

class TypeValidationError(val value: Any?, cause: Throwable, val context: TypeValidationContext? = null) : AiSdkException

UiMessageStreamError

class UiMessageStreamError(message: String, cause: Throwable? = null) : AiSdkException

UnauthorizedError

class UnauthorizedError(message: String = "Unauthorized") : AiSdkException

UnsupportedFunctionalityError

class UnsupportedFunctionalityError(val functionality: String, message: String = "'") : AiSdkException

UnsupportedModelVersionError

class UnsupportedModelVersionError(modelId: String, version: String) : AiSdkException

Usage

@Serializable

data class Usage(val inputTokens: Usage.InputTokenBreakdown = InputTokenBreakdown(), val outputTokens: Usage.OutputTokenBreakdown = OutputTokenBreakdown(), val raw: JsonElement? = null)

Token-usage tracking, surfaced on completed steps and final results. Per historical parity gap #19, the shape mirrors v6's rich tree — input tokens split into noCache / cacheRead / cacheWrite and output tokens split into text / reasoning plus a raw slot for provider-specific payloads.

UseCompletionOptions

data class UseCompletionOptions(val api: String = "/api/completion", val id: String = generateId("completion"), val initialCompletion: String = "", val initialInput: String = "", val headers: Map<String, String> = emptyMap(), val body: Map<String, JsonElement> = emptyMap(), val streamProtocol: CompletionStreamProtocol = CompletionStreamProtocol.Data, val transport: CompletionTransport = DirectCompletionTransport { emptyFlow() }, val onFinish: suspend (prompt: String, completion: String) -> Unit = { _, _ -> }, val onError: suspend (Throwable) -> Unit = {})

ValidationResult

sealed interface ValidationResult<out T>

VideoGenerationParams

data class VideoGenerationParams(val prompt: String, val n: Int = 1, val image: GeneratedFile? = null, val durationSeconds: Float? = null, val size: String? = null, val aspectRatio: String? = null, val providerOptions: Map<String, JsonElement> = emptyMap(), val headers: Map<String, String> = emptyMap(), val abortSignal: AbortSignal = AbortSignalNever, val seed: Int? = null, val fps: Int? = null, val resolution: String? = null)

VideoModel

interface VideoModel

VideoModelResult

data class VideoModelResult(val videos: List<GeneratedFile>, val warnings: List<CallWarning> = emptyList(), val response: LanguageModelResponseMetadata = LanguageModelResponseMetadata(), val providerMetadata: Map<String, JsonElement> = emptyMap())

WireDecodeException

class WireDecodeException(val provider: String, val operation: String, val path: String, message: String, val value: JsonElement? = null, cause: Throwable? = null) : AiSdkException

Properties

AbortSignalNever

val AbortSignalNever: AbortSignal

A signal that is never aborted. Useful as a default.

AI_GATEWAY_DEFAULT_BASE_URL

const val AI_GATEWAY_DEFAULT_BASE_URL: String

AI_GATEWAY_PROTOCOL_VERSION

const val AI_GATEWAY_PROTOCOL_VERSION: String

gateway

val gateway: GatewayProvider

GATEWAY_AUTH_METHOD_HEADER

const val GATEWAY_AUTH_METHOD_HEADER: String

globalTelemetry

val globalTelemetry: TelemetryRegistry

Global registry — upstream v7 registerTelemetry: register once at startup, all calls emit.

LATEST_PROTOCOL_VERSION

const val LATEST_PROTOCOL_VERSION: String

MCP_PACKAGE_VERSION

const val MCP_PACKAGE_VERSION: String

metadata

val ContentPart.metadata: Map<String, JsonElement>?

val StreamEvent.metadata: Map<String, JsonElement>?

SUPPORTED_PROTOCOL_VERSIONS

val SUPPORTED_PROTOCOL_VERSIONS: List<String>

Functions

abortSignalFromJob

fun abortSignalFromJob(job: Job): AbortSignal

Bind an abort signal to a Job so the signal fires when the job completes (cancelled or otherwise). Lets a parent scope's lifetime automatically cancel anything observing the signal.

abortSignalFromJobs

fun abortSignalFromJobs(vararg jobs: Job): AbortSignal

allOf

fun allOf(vararg conditions: StopCondition): StopCondition

Stop only when all conditions report done.

anyOf

fun anyOf(vararg conditions: StopCondition): StopCondition

Stop when any of conditions reports done. v6's array-of-conditions shape.

asAbortSignal

fun CoroutineScope.asAbortSignal(): AbortSignal

fun Job.asAbortSignal(): AbortSignal

asArray

fun <T> asArray(value: Iterable<T>): List<T>

asSchema

fun <T> asSchema(schema: LazySchema<T>): Schema<T>

fun <T> asSchema(schema: Schema<T>?): Schema<T>

assistantMessage

fun assistantMessage(text: String): ModelMessage

buildProviderOptions

fun buildProviderOptions(block: ProviderOptionsBuilder.() -> Unit): Map<String, JsonElement>

bytes

fun GeneratedFile.bytes(): ByteArray

Decode the inline base64 payload to bytes.

bytesOrNull

fun GeneratedFile.bytesOrNull(): ByteArray?

Like bytes but returns null for a URL-backed file instead of throwing.

callCompletionApi

suspend fun callCompletionApi(options: CallCompletionApiOptions): String?

callSettings

fun callSettings(block: CallSettingsBuilder.() -> Unit): CallSettings

clearGlobalTelemetry

fun clearGlobalTelemetry()

combineAbortSignals

fun combineAbortSignals(vararg signals: AbortSignal): AbortSignal

convertBase64ToByteArray

fun convertBase64ToByteArray(base64String: String): ByteArray

convertByteArrayToBase64

fun convertByteArrayToBase64(array: ByteArray): String

convertModelMessages

fun convertModelMessages(modelMessages: List<ModelMessage>): List<LangChainBaseMessage>

convertToBase64

fun convertToBase64(value: ByteArray): String

convertToLanguageModelPrompt

suspend fun convertToLanguageModelPrompt(messages: List<ModelMessage>, supportedUrls: Map<String, List<String>> = emptyMap(), download: DownloadFunction? = null): List<ModelMessage>

Resolve a prompt for a specific model — the port of upstream's convertToLanguageModelPrompt:

cosineSimilarity

fun cosineSimilarity(left: List<Float>, right: List<Float>): Float

createGateway

fun createGateway(settings: GatewayProviderSettings = GatewayProviderSettings()): GatewayProvider

createGatewayHttpProvider

fun createGatewayHttpProvider(client: HttpClient, settings: GatewayProviderSettings = GatewayProviderSettings(), json: Json = aiSdkJson): GatewayProvider

createGatewayProvider

fun createGatewayProvider(settings: GatewayProviderSettings = GatewayProviderSettings()): GatewayProvider

createIdGenerator

fun createIdGenerator(prefix: String? = null, size: Int = 16, alphabet: String = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", separator: String = "-", random: Random = Random.Default): IdGenerator

createMCPClient

suspend fun createMCPClient(config: MCPClientConfig): MCPClient

createMcpTransport

fun createMcpTransport(client: HttpClient, config: MCPTransportConfig): MCPTransport

createProviderRegistry

fun createProviderRegistry(providers: Map<String, Provider>, defaultProviderId: String? = null, separator: String = ":", languageModelMiddleware: List<LanguageModelMiddleware> = emptyList()): ProviderRegistry

fun createProviderRegistry(vararg providers: Pair<String, Provider>, defaultProviderId: String? = null, separator: String = ":", languageModelMiddleware: List<LanguageModelMiddleware> = emptyList()): ProviderRegistry

createProviderToolFactory

fun <TInput, TContext> createProviderToolFactory(id: String, inputSerializer: KSerializer<TInput>, inputSchema: Schema<TInput>, description: String = "Provider tool "): ProviderToolFactory<TInput, TContext>

createProviderToolFactoryWithOutputSchema

fun <TInput, TOutput, TContext> createProviderToolFactoryWithOutputSchema(id: String, inputSerializer: KSerializer<TInput>, inputSchema: Schema<TInput>, outputSerializer: KSerializer<TOutput>, outputSchema: Schema<TOutput>, supportsDeferredResults: Boolean = false, description: String = "Provider tool "): ProviderToolFactoryWithOutputSchema<TInput, TOutput, TContext>

createToolNameMapping

fun createToolNameMapping(tools: List<LanguageModelTool> = emptyList(), providerToolNames: Map<String, String>, resolveProviderToolName: (LanguageModelTool) -> String?? = null): ToolNameMapping

customProvider

fun customProvider(providerId: String, languageModels: Map<String, LanguageModel> = emptyMap(), embeddingModels: Map<String, EmbeddingModel> = emptyMap(), imageModels: Map<String, ImageModel> = emptyMap(), speechModels: Map<String, SpeechModel> = emptyMap(), transcriptionModels: Map<String, TranscriptionModel> = emptyMap(), rerankingModels: Map<String, RerankingModel> = emptyMap(), videoModels: Map<String, VideoModel> = emptyMap(), fallbackProvider: Provider? = null): Provider

decodeAs

inline fun <T> JsonElement.decodeAs(): T

fun <T> JsonElement.decodeAs(serializer: KSerializer<T>): T

decodeProviderMetadata

inline fun <T> Map<String, JsonElement>?.decodeProviderMetadata(provider: String): T?

fun <T> Map<String, JsonElement>?.decodeProviderMetadata(provider: String, serializer: KSerializer<T>): T?

decodeValue

inline fun <T> Map<String, JsonElement>.decodeValue(name: String): T?

fun <T> Map<String, JsonElement>.decodeValue(name: String, serializer: KSerializer<T>): T?

defaultEmbeddingSettingsMiddleware

fun defaultEmbeddingSettingsMiddleware(maxEmbeddingsPerCall: Int? = null, truncate: Boolean? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap()): EmbeddingModelMiddleware

detectMediaType

fun detectMediaType(filename: String? = null, dataUrl: String? = null, explicit: String? = null): String?

devToolsMiddleware

fun devToolsMiddleware(recorder: DevToolsRecorder = InMemoryDevToolsRecorder(), environment: String = "development", runId: String = generateId(prefix = "run"), idGenerator: () -> String = { generateId(prefix = "step") }): LanguageModelMiddleware

dynamicTool

fun <TContext> dynamicTool(name: String, description: String, inputSchemaJson: String = "{}", metadata: Map<String, JsonElement> = emptyMap(), toModelOutput: (JsonElement, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, executor: suspend ToolExecutionContext<TContext>.(JsonElement) -> JsonElement): Tool<JsonElement, JsonElement, TContext>

Runtime-typed tool equivalent to v6's dynamicTool. Inputs and outputs are raw JsonElement values, so the tool can be registered from external manifests or MCP-style runtime catalogs.

effectiveApprovalId

fun effectiveApprovalId(approval: PendingApproval): String

The effective approval ID — explicit PendingApproval.approvalId or fallback to PendingApproval.toolCallId.

embed

suspend fun embed(model: EmbeddingModel, value: String, providerOptions: Map<String, JsonElement> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, headers: Map<String, String> = emptyMap(), maxRetries: Int = 2): EmbedResult<String>

embeddingModel

fun Provider.embeddingModel(modelId: ModelId): EmbeddingModel

fun Provider.embeddingModel(ref: ModelRef): EmbeddingModel

embedMany

suspend fun embedMany(model: EmbeddingModel, values: List<String>, maxEmbeddingsPerCall: Int? = null, maxParallelCalls: Int = Int.MAX_VALUE, providerOptions: Map<String, JsonElement> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, headers: Map<String, String> = emptyMap(), maxRetries: Int = 2): EmbedManyResult<String>

encodeJsonElement

inline fun <T> encodeJsonElement(value: T): JsonElement

fun <T> encodeJsonElement(value: T, serializer: KSerializer<T>): JsonElement

executeTool

fun <TInput, TOutput, TContext> executeTool(tool: Tool<TInput, TOutput, TContext>, input: TInput, options: ToolExecutionContext<TContext>): Flow<ExecuteToolResult<TOutput>>

experimental_createMCPClient

suspend fun experimental_createMCPClient(config: MCPClientConfig): MCPClient

experimental_generateImage

suspend fun experimental_generateImage(model: ImageModel, prompt: String, n: Int = 1, size: String? = null, aspectRatio: String? = null, seed: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, files: List<ImageGenerationFile> = emptyList(), mask: ImageGenerationFile? = null): GenerateImageResult

experimental_generateSpeech

suspend fun experimental_generateSpeech(model: SpeechModel, text: String, voice: String? = null, instructions: String? = null, speed: Float? = null, responseFormat: String? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever): GenerateSpeechResult

experimental_generateVideo

suspend fun experimental_generateVideo(model: VideoModel, prompt: String, n: Int = 1, image: GeneratedFile? = null, durationSeconds: Float? = null, size: String? = null, aspectRatio: String? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, seed: Int? = null, fps: Int? = null, resolution: String? = null): GenerateVideoResult

experimental_transcribe

suspend fun experimental_transcribe(model: TranscriptionModel, audio: AudioSource, language: String? = null, prompt: String? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever): TranscribeResult

fileData

fun GeneratedFile.fileData(): FileData

fixJson

fun fixJson(input: String): String

Complete a partial/truncated JSON string so Json.parseToJsonElement can read it. Returns "" when nothing valid was scanned (e.g. a lone -). See parsePartialJson for the parse wrapper.

generatedFile

fun generatedFile(data: FileData, mediaType: String = data.mediaType ?: "application/octet-stream", filename: String? = data.filename, providerMetadata: Map<String, JsonElement> = emptyMap()): GeneratedFile

generateId

fun generateId(prefix: String? = null, random: Random = Random.Default): String

generateImage

suspend fun generateImage(model: ImageModel, prompt: String, n: Int = 1, size: String? = null, aspectRatio: String? = null, seed: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, files: List<ImageGenerationFile> = emptyList(), mask: ImageGenerationFile? = null, logger: Logger = NoopLogger): GenerateImageResult

generateObject

suspend fun <TOutput> ~~generateObject~~(model: LanguageModel, output: Output<TOutput>, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, temperature: Float? = null, topP: Float? = null, topK: Int? = null, maxOutputTokens: Int? = null, stopSequences: List<String> = emptyList(), seed: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, presencePenalty: Float? = null, frequencyPenalty: Float? = null, responseFormat: ResponseFormat = ResponseFormat.Text): GenerateObjectResult<TOutput>

Deprecated v6 compatibility helper. Prefer generateText with output = ...; this wrapper exists for call sites that still use the object-generation vocabulary.

generateSpeech

suspend fun generateSpeech(model: SpeechModel, text: String, voice: String? = null, instructions: String? = null, speed: Float? = null, responseFormat: String? = null, language: String? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, logger: Logger = NoopLogger): GenerateSpeechResult

generateText

suspend fun generateText(model: LanguageModel, request: TextGenerationRequest): GenerateTextResult<String>

suspend fun generateText(model: LanguageModel, settings: CallSettings = CallSettings(), block: TextGenerationRequestBuilder.() -> Unit): GenerateTextResult<String>

suspend fun <TOutput> generateText(model: LanguageModel, output: Output<TOutput>, request: TextGenerationRequest): GenerateTextResult<TOutput>

suspend fun <TOutput> generateText(model: LanguageModel, output: Output<TOutput>, settings: CallSettings = CallSettings(), block: TextGenerationRequestBuilder.() -> Unit): GenerateTextResult<TOutput>

suspend fun generateText(model: LanguageModel, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, settings: CallSettings): GenerateTextResult<String>

suspend fun <TOutput> generateText(model: LanguageModel, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, output: Output<TOutput>, temperature: Float? = null, topP: Float? = null, topK: Int? = null, maxOutputTokens: Int? = null, stopSequences: List<String> = emptyList(), seed: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, presencePenalty: Float? = null, frequencyPenalty: Float? = null, responseFormat: ResponseFormat = ResponseFormat.Text): GenerateTextResult<TOutput>

suspend fun generateText(model: LanguageModel, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, temperature: Float? = null, topP: Float? = null, topK: Int? = null, maxOutputTokens: Int? = null, stopSequences: List<String> = emptyList(), seed: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, presencePenalty: Float? = null, frequencyPenalty: Float? = null, responseFormat: ResponseFormat = ResponseFormat.Text): GenerateTextResult<String>

One-shot generation — invariant I-3, the only text entry point in v6.

generateVideo

suspend fun generateVideo(model: VideoModel, prompt: String, n: Int = 1, image: GeneratedFile? = null, durationSeconds: Float? = null, size: String? = null, aspectRatio: String? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, seed: Int? = null, fps: Int? = null, resolution: String? = null, logger: Logger = NoopLogger): GenerateVideoResult

hasToolCall

fun hasToolCall(toolName: String): StopCondition

Stop the moment the named tool is called in any step.

imageGenerationFile

fun imageGenerationFile(data: FileData): ImageGenerationFile

imageModel

fun Provider.imageModel(modelId: ModelId): ImageModel

fun Provider.imageModel(ref: ModelRef): ImageModel

injectJsonInstruction

fun injectJsonInstruction(prompt: String? = null, schema: JsonElement? = null, schemaPrefix: String? = if (schema != null) DEFAULT_SCHEMA_PREFIX else null, schemaSuffix: String? = if (schema != null) DEFAULT_SCHEMA_SUFFIX else DEFAULT_GENERIC_SUFFIX): String

Build the JSON instruction block.

injectJsonInstructionIntoMessages

fun injectJsonInstructionIntoMessages(messages: List<ModelMessage>, schema: JsonElement? = null, schemaPrefix: String? = if (schema != null) DEFAULT_SCHEMA_PREFIX else null, schemaSuffix: String? = if (schema != null) DEFAULT_SCHEMA_SUFFIX else DEFAULT_GENERIC_SUFFIX): List<ModelMessage>

Splice injectJsonInstruction into a message list's system prompt.

isLoopFinished

suspend fun isLoopFinished(state: LoopState, stopWhen: StopCondition): Boolean

Consolidated check: would the loop terminate after this state?

isToolResultError

fun ToolResultOutput.isToolResultError(): Boolean

isUrlSupported

fun isUrlSupported(mediaType: String, url: String, supportedUrls: Map<String, List<Regex>>): Boolean

jsonSchema

fun <T> jsonSchema(schema: JsonElement, validate: (JsonElement) -> T? = null): Schema<T>

langChainToUIMessageStream

fun langChainToUIMessageStream(stream: Flow<LangChainStreamItem>, callbacks: StreamCallbacks? = null, assistantMessageId: String = "langchain-msg-1"): Flow<UIMessage>

languageModel

fun Provider.languageModel(modelId: ModelId): LanguageModel

fun Provider.languageModel(ref: ModelRef): LanguageModel

lazySchema

fun <T> lazySchema(createSchema: () -> Schema<T>): LazySchema<T>

llamaIndexToUIMessageStream

fun llamaIndexToUIMessageStream(stream: Flow<LlamaIndexEngineResponse>, callbacks: StreamCallbacks? = null, assistantMessageId: String = "1"): Flow<UIMessage>

maybeSignToolApproval

fun maybeSignToolApproval(secret: ByteArray?, approvalId: String, toolCallId: String, toolName: String, input: JsonElement): String?

Sign when a secret is configured; null otherwise (upstream maybeSignApproval).

mergeAbortSignals

fun mergeAbortSignals(vararg signals: AbortSignal): AbortSignal

modelId

fun modelId(value: String): ModelId

modelRef

fun modelRef(value: String): ModelRef

fun modelRef(providerId: ProviderId, modelId: ModelId): ModelRef

fun modelRef(providerId: String, modelId: String): ModelRef

modelRepromptRepair

fun <TContext> modelRepromptRepair(model: LanguageModel): ToolCallRepairFunction<TContext>

Stock self-healing repair: re-prompt the model with the tool's JSON schema + the failed args + the parse error, asking for corrected JSON. If the second response parses cleanly, return a ContentPart.ToolCall with the corrected input; otherwise return null (the agent loop surfaces StreamEvent.ToolError).

outputArray

fun <T> outputArray(elementSerializer: KSerializer<T>, name: String = elementSerializer.descriptor.serialName.substringAfterLast('.') + "[]", description: String? = null): Output<List<T>>

outputChoice

fun outputChoice(options: Iterable<String>, name: String = "choice", description: String? = null): Output<String>

fun outputChoice(vararg options: String, name: String = "choice", description: String? = null): Output<String>

fun <T> outputChoice(options: Iterable<T>, encode: (T) -> String, decodeChoice: (String) -> T, name: String = "choice", description: String? = null): Output<T>

outputJson

fun outputJson(name: String = "json", description: String? = null): Output<JsonElement>

outputObj

fun <T> outputObj(serializer: KSerializer<T>, name: String = serializer.descriptor.serialName.substringAfterLast('.'), description: String? = null): Output<T>

parseJsonEventStream

fun <T> parseJsonEventStream(chunks: Flow<String>, schema: Schema<T>, json: Json = Json): Flow<ParseResult<T>>

parsePartialJson

fun parsePartialJson(jsonText: String?): PartialJsonResult

Parse possibly-partial JSON. Mirrors Vercel AI SDK v6 parsePartialJson:

parseProviderOptions

fun <T> parseProviderOptions(provider: String, providerOptions: Map<String, JsonElement>, schema: Schema<T>): T?

plus

operator fun Usage.plus(other: Usage): Usage

provider

fun Provider.provider(providerId: ProviderId): Provider

providerExecutedTool

fun <TInput, TOutput, TContext> providerExecutedTool(name: String, description: String, inputSerializer: KSerializer<TInput>, outputSerializer: KSerializer<TOutput>, metadata: Map<String, JsonElement> = emptyMap()): Tool<TInput, TOutput, TContext>

providerId

fun providerId(value: String): ProviderId

providerMetadata

fun Map<String, JsonElement>?.providerMetadata(provider: String): JsonElement?

providerMetadataAs

inline fun <T> ContentPart.providerMetadataAs(provider: String): T?

inline fun <T> GenerateObjectResult<*>.providerMetadataAs(provider: String): T?

inline fun <T> GenerateTextResult<*>.providerMetadataAs(provider: String): T?

inline fun <T> LanguageModelResult.providerMetadataAs(provider: String): T?

inline fun <T> StreamEvent.providerMetadataAs(provider: String): T?

fun <T> ContentPart.providerMetadataAs(provider: String, serializer: KSerializer<T>): T?

fun <T> GenerateObjectResult<*>.providerMetadataAs(provider: String, serializer: KSerializer<T>): T?

fun <T> GenerateTextResult<*>.providerMetadataAs(provider: String, serializer: KSerializer<T>): T?

fun <T> LanguageModelResult.providerMetadataAs(provider: String, serializer: KSerializer<T>): T?

fun <T> StreamEvent.providerMetadataAs(provider: String, serializer: KSerializer<T>): T?

pruneMessages

fun pruneMessages(messages: List<ModelMessage>, reasoning: PruneReasoning = PruneReasoning.None, toolCalls: PruneToolCalls = PruneToolCalls.None, emptyMessages: PruneEmptyMessages = PruneEmptyMessages.Remove): List<ModelMessage>

putJson

inline fun <T> JsonObjectBuilder.putJson(name: String, value: T)

fun <T> JsonObjectBuilder.putJson(name: String, value: T, serializer: KSerializer<T>)

putJsonIfNotNull

inline fun <T> JsonObjectBuilder.putJsonIfNotNull(name: String, value: T?)

fun <T> JsonObjectBuilder.putJsonIfNotNull(name: String, value: T?, serializer: KSerializer<T>)

registerTelemetry

fun registerTelemetry(integration: Telemetry)

repeatedToolCallLoop

fun repeatedToolCallLoop(n: Int): StopCondition

Stop when the model has emitted the same (toolName, input) tuple n consecutive steps in a row — i.e. the loop is spinning on a tool whose result didn't change the model's behavior. Documented anti-pattern for small / on-device models that can't reason their way out of an unhelpful tool result; surfaced as a hard stop so the host renders the trapped state instead of looping until the step cap.

rerank

suspend fun rerank(model: RerankingModel, query: String, documents: List<String>, topN: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, maxRetries: Int = 2): RerankResult<String>

rerankingModel

fun Provider.rerankingModel(modelId: ModelId): RerankingModel

fun Provider.rerankingModel(ref: ModelRef): RerankingModel

retryWithExponentialBackoff

suspend fun <T> retryWithExponentialBackoff(policy: RetryPolicy = RetryPolicy(), shouldRetry: (Throwable) -> Boolean = { true }, block: suspend (attempt: Int) -> T): T

Retry block with exponential backoff, honoring server Retry-After headers, and surfacing the full attempt history as a RetryError on exhaustion — the contract upstream's retryWithExponentialBackoff exposes.

safeValidateTypes

fun <T> safeValidateTypes(value: JsonElement, schema: LazySchema<T>, context: TypeValidationContext? = null): ValidationResult<T>

fun <T> safeValidateTypes(value: JsonElement, schema: Schema<T>, context: TypeValidationContext? = null): ValidationResult<T>

session

fun <TContext, TOutput> Agent<TContext, TOutput>.session(scope: CoroutineScope, initialMessages: List<ModelMessage> = emptyList()): AgentSession<TContext, TOutput>

signToolApproval

fun signToolApproval(secret: ByteArray, approvalId: String, toolCallId: String, toolName: String, input: JsonElement): String

Sign one approval request. approvalId is the EFFECTIVE id (explicit approvalId ?: toolCallId).

simulateReadableStream

fun simulateReadableStream(events: List<StreamEvent>, initialDelayMs: Long = 0, chunkDelayMs: Long = 10): Flow<StreamEvent>

Replay a recorded list of StreamEvents as a fresh cold Flow with configurable inter-chunk delay. Foundation for the caching middleware pattern: cache stream parts as List<StreamEvent>, on cache hit replay via simulateReadableStream so the stream contract is preserved.

smoothStream

fun smoothStream(upstream: Flow<StreamEvent>, delayMs: Long = 10, chunkBy: ChunkBy = ChunkBy.Word): Flow<StreamEvent>

speechModel

fun Provider.speechModel(modelId: ModelId): SpeechModel

fun Provider.speechModel(ref: ModelRef): SpeechModel

splitDataUrl

fun splitDataUrl(dataUrl: String): DataUrl

splitProviderModelId

fun splitProviderModelId(modelId: String, separator: String = ":"): Pair<String?, String>

stepCountIs

fun stepCountIs(n: Int): StopCondition

Stop after n completed steps. v6's default is 20 if stopWhen omitted.

streamingTool

inline fun <TInput, TOutput, TContext> streamingTool(name: String, description: String, noinline needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, noinline toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, strict: Boolean = true, inputExamples: List<String> = emptyList(), noinline onInputStart: suspend (streamingId: String) -> Unit? = null, noinline onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, noinline onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null, metadata: Map<String, JsonElement> = emptyMap(), providerExecuted: Boolean = false, noinline executor: ToolExecutionContext<TContext>.(TInput) -> Flow<TOutput>): Tool<TInput, TOutput, TContext>

fun <TInput, TOutput, TContext> streamingTool(name: String, description: String, inputSerializer: KSerializer<TInput>, outputSerializer: KSerializer<TOutput>, needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, strict: Boolean = true, inputExamples: List<String> = emptyList(), onInputStart: suspend (streamingId: String) -> Unit? = null, onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null, metadata: Map<String, JsonElement> = emptyMap(), providerExecuted: Boolean = false, executor: ToolExecutionContext<TContext>.(TInput) -> Flow<TOutput>): Tool<TInput, TOutput, TContext>

Top-level factory for Tool with a Flow-returning executor. Each emission lands as a StreamEvent.ToolResult; the LAST emission is the final tool result that feeds the model on subsequent turns, and all earlier emissions are surfaced as ToolResult(preliminary = true) for UI consumption only.

streamObject

fun <TOutput> ~~streamObject~~(model: LanguageModel, output: Output<TOutput>, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, temperature: Float? = null, topP: Float? = null, topK: Int? = null, maxOutputTokens: Int? = null, stopSequences: List<String> = emptyList(), seed: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, presencePenalty: Float? = null, frequencyPenalty: Float? = null, responseFormat: ResponseFormat = ResponseFormat.Text): Flow<StreamEvent>

Deprecated v6 compatibility helper. Prefer streamText with output = ...; the KMP core streams typed StreamEvent values instead of returning a browser/Node stream facade.

streamObjectResult

fun <TOutput> streamObjectResult(model: LanguageModel, output: Output<TOutput>, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, temperature: Float? = null, topP: Float? = null, topK: Int? = null, maxOutputTokens: Int? = null, stopSequences: List<String> = emptyList(), seed: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, presencePenalty: Float? = null, frequencyPenalty: Float? = null, responseFormat: ResponseFormat = ResponseFormat.Text, repairText: (String) -> String?? = null): StreamObjectResult<TOutput>

Stream a structured object, returning a typed StreamObjectResult — the v6 streamObject surface (the older streamObject returns a raw event flow and is deprecated). Use StreamObjectResult.partialObjectStream for incremental UI or StreamObjectResult.objectValue for the final value.

streamText

fun streamText(model: LanguageModel, request: TextGenerationRequest): Flow<StreamEvent>

fun streamText(model: LanguageModel, settings: CallSettings = CallSettings(), block: TextGenerationRequestBuilder.() -> Unit): Flow<StreamEvent>

fun streamText(model: LanguageModel, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, temperature: Float? = null, topP: Float? = null, topK: Int? = null, maxOutputTokens: Int? = null, stopSequences: List<String> = emptyList(), seed: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, output: Output<*>? = null, presencePenalty: Float? = null, frequencyPenalty: Float? = null, responseFormat: ResponseFormat = ResponseFormat.Text): Flow<StreamEvent>

Streaming generation — invariant I-3. Returns a cold Flow that drives one upstream call when collected. For tool-loop agents, use Agent.stream instead.

streamTextResult

fun streamTextResult(model: LanguageModel, request: TextGenerationRequest): StreamTextResult

fun streamTextResult(model: LanguageModel, settings: CallSettings = CallSettings(), block: TextGenerationRequestBuilder.() -> Unit): StreamTextResult

fun streamTextResult(model: LanguageModel, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, settings: CallSettings): StreamTextResult

fun streamTextResult(model: LanguageModel, prompt: String? = null, messages: List<ModelMessage> = emptyList(), system: String? = null, temperature: Float? = null, topP: Float? = null, topK: Int? = null, maxOutputTokens: Int? = null, stopSequences: List<String> = emptyList(), seed: Int? = null, providerOptions: Map<String, JsonElement> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, output: Output<*>? = null, presencePenalty: Float? = null, frequencyPenalty: Float? = null, responseFormat: ResponseFormat = ResponseFormat.Text): StreamTextResult

systemMessage

fun systemMessage(text: String): ModelMessage

textGenerationRequest

fun textGenerationRequest(block: TextGenerationRequestBuilder.() -> Unit): TextGenerationRequest

toBaseMessages

fun toBaseMessages(messages: List<UIMessage>): List<LangChainBaseMessage>

toJsonElement

fun ToolResultOutput.toJsonElement(): JsonElement

tool

inline fun <TInput, TOutput, TContext> tool(name: String, description: String, noinline needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, noinline toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, strict: Boolean = true, inputExamples: List<String> = emptyList(), noinline onInputStart: suspend (streamingId: String) -> Unit? = null, noinline onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, noinline onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null, metadata: Map<String, JsonElement> = emptyMap(), providerExecuted: Boolean = false, noinline executor: suspend ToolExecutionContext<TContext>.(TInput) -> TOutput): Tool<TInput, TOutput, TContext>

fun <TInput, TOutput, TContext> tool(name: String, description: String, inputSerializer: KSerializer<TInput>, outputSerializer: KSerializer<TOutput>, needsApproval: suspend (input: TInput, options: ToolPredicateOptions<TContext>) -> Boolean? = null, toModelOutput: (TOutput, ToolPredicateOptions<TContext>) -> ToolResultOutput? = null, strict: Boolean = true, inputExamples: List<String> = emptyList(), onInputStart: suspend (streamingId: String) -> Unit? = null, onInputDelta: suspend (streamingId: String, delta: String) -> Unit? = null, onInputAvailable: suspend (toolCallId: String, input: TInput) -> Unit? = null, metadata: Map<String, JsonElement> = emptyMap(), providerExecuted: Boolean = false, providerOptions: Map<String, JsonElement> = emptyMap(), executor: suspend ToolExecutionContext<TContext>.(TInput) -> TOutput): Tool<TInput, TOutput, TContext>

Top-level factory for Tool with a single-value executor. Mirrors v6's tool({...}) ergonomics in an idiomatic common Kotlin shape.

toolApprovalResponseMessage

fun toolApprovalResponseMessage(toolCallId: String, approved: Boolean, reason: String? = null, approvalId: String? = null): ModelMessage

toolMessage

fun toolMessage(toolCallId: String, toolName: String, output: JsonElement): ModelMessage

toolSet

fun <TContext> toolSet(block: ToolSetBuilder<TContext>.() -> Unit): ToolSet<TContext>

toolSetOf

fun <TContext> toolSetOf(vararg tools: Tool<*, *, TContext>): ToolSet<TContext>

Construct a ToolSet from individual tools. Throws on duplicate names.

toUIMessageStream

@JvmName(name = "langChainToUIMessageStreamExport")

fun toUIMessageStream(stream: Flow<LangChainStreamItem>, callbacks: StreamCallbacks? = null, assistantMessageId: String = "langchain-msg-1"): Flow<UIMessage>

fun toUIMessageStream(stream: Flow<LlamaIndexEngineResponse>, callbacks: StreamCallbacks? = null, assistantMessageId: String = "1"): Flow<UIMessage>

transcribe

suspend fun transcribe(model: TranscriptionModel, audio: AudioSource, language: String? = null, prompt: String? = null, providerOptions: Map<String, JsonElement> = emptyMap(), headers: Map<String, String> = emptyMap(), abortSignal: AbortSignal = AbortSignalNever, logger: Logger = NoopLogger): TranscribeResult

transcriptionModel

fun Provider.transcriptionModel(modelId: ModelId): TranscriptionModel

fun Provider.transcriptionModel(ref: ModelRef): TranscriptionModel

userMessage

fun userMessage(text: String): ModelMessage

validateDownloadUrl

fun validateDownloadUrl(url: String)

validateTypes

fun <T> validateTypes(value: JsonElement, schema: LazySchema<T>, context: TypeValidationContext? = null): T

fun <T> validateTypes(value: JsonElement, schema: Schema<T>, context: TypeValidationContext? = null): T

verifyToolApprovalSignature

fun verifyToolApprovalSignature(secret: ByteArray, signature: String, approvalId: String, toolCallId: String, toolName: String, input: JsonElement): Boolean

Verify a replayed approval's signature. Constant-time comparison; false on any malformed input.

videoModel

fun Provider.videoModel(modelId: ModelId): VideoModel

fun Provider.videoModel(ref: ModelRef): VideoModel

wrapEmbeddingModel

fun wrapEmbeddingModel(model: EmbeddingModel, middlewares: List<EmbeddingModelMiddleware>): EmbeddingModel

wrapImageModel

fun wrapImageModel(model: ImageModel, middlewares: List<ImageModelMiddleware>): ImageModel

wrapLanguageModel

fun wrapLanguageModel(model: LanguageModel, middlewares: List<LanguageModelMiddleware>): LanguageModel

Compose middlewares over model into a new LanguageModel. Order: the first middleware in the list is the outermost wrapper — wrapGenerate runs first on the way in, last on the way out (innermost in the call stack, like Express middleware).

wrapProvider

fun wrapProvider(provider: Provider, middleware: ProviderMiddleware): Provider